Release Checklist

The release checklist is a manual set of checks done before each release to ensure functionality of the most critical components of the application.

This checklist should be copy/pasted into the final pre-release PR, and checked off as you complete each step.

Pre-Release Steps

General

From the release branch, confirm the following:

• Quickstart works: nox -s quickstart (verify you can complete the interactive prompts from the command-line)
• Test environment works: nox -s "fides_env(test)" (verify the admin UI on localhost:8080, privacy center on localhost:3001, CLI and webserver)

Next, run the following checks via the test environment:

API

• Verify that the generated API docs are correct @ http://localhost:8080/docs

CLI

Run these from within the test environment shell:

• git reset --hard - Note: This is required for the pull command to work
• fides user login
• fides push src/fides/data/sample_project/sample_resources/
• fides pull src/fides/data/sample_project/sample_resources/
• fides evaluate src/fides/data/sample_project/sample_resources/
• fides generate dataset db --credentials-id app_postgres test.yml - Note: Because the filesystem isn't mounted, the new file will only show up within the container
• fides scan dataset db --credentials-id app_postgres

Privacy Center

• Every navigation button works
• DSR submission succeeds
• Consent request submission succeeds

Admin UI

• Every navigation button works
• Login/logout succeeds
• DSR approval succeeds
• DSR execution succeeds

Documentation

• Verify that the CHANGELOG is formatted correctly and representative of the actual changes

⚠️ Note that any updates that need to be made to the CHANGELOG should not be commited directly to the release branch.
Instead, they should be committed on a branch off of main and then PR'd and merged into main, before being cherry-picked over to the release branch. This ensures that the CHANGELOG stays consistent between the release branch and main.

Publishing the release

When publishing the release, be sure to include the following sections in the release description:

• ## Release Pull Request section that includes a link back to the release PR (i.e., this one!) for tracking purposes

Post-Release Steps

• Verify the ethyca-fides release is published to PyPi: https://pypi.org/project/ethyca-fides/#history
• Verify the fides release is published to DockerHub: https://hub.docker.com/r/ethyca/fides
• Verify the fides-privacy-center release is published to DockerHub: https://hub.docker.com/r/ethyca/fides-privacy-center
• Verify the fides-sample-app release is published to DockerHub: https://hub.docker.com/r/ethyca/fides-sample-app